home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 9 / Night Owl CD-ROM (NOPV9) (Night Owl Publisher) (1993).ISO / 011a / cexyz99a.zip / CEXYZ.DOC next >
Text File  |  1993-02-07  |  16KB  |  381 lines
  1.  
  2.                              CE-XYZ v0.99a Beta
  3.                       A File Transfer Protocol Module
  4.  
  5.                 Copyright (C) 1993 by Cutting Edge Computing
  6.                             All Rights Reserved.
  7.  
  8.  
  9. LICENSE AGREEMENT
  10. -----------------
  11. This Beta copy of the software has been provided for wide beta testing and
  12. may be distributed via File Distribution Networks and other BBS systems.
  13.  
  14. This program is free for non-commercial use.  Commercial users are granted
  15. a license to use CE-XYZ if, and only if, the user has purchased a license
  16. to use The Blue Wave Offline Mail Door.  Your Blue Wave Offline Mail Door
  17. Registration Certificate is sufficient "proof" of license to use this
  18. protocol module.
  19.  
  20. If you are a commercial user and would like to use this protocol module for
  21. other purposes, please write to the address below with contact information
  22. so that we may negotiate a license fee.
  23.  
  24. Software authors that would like to distribute CE-XYZ in their distribution
  25. packages will be granted a license to do so for a reasonable, one-time
  26. licensing fee.  Please contact me at the address below for more
  27. information.
  28.  
  29. Cutting Edge Computing
  30. PO Box 90476
  31. Burton, MI  48509
  32.  
  33. FidoNet : 1:2240/176
  34. InterNet: george.hatchew@f176.n2240.z1.fidonet.org
  35.  
  36.  
  37. WARRANTY
  38. --------
  39. There is no warranty for this software, either expressed or implied.  The
  40. user assumes full responsibility for the use of this software.
  41.  
  42.  
  43. SUPPORT
  44. -------
  45. Because this is a "free for non-commercial use" program, no support will be
  46. given for this program, except in the following cases:
  47.  
  48.   1)  User has also registered one of The Blue Wave Offline Mail Doors.
  49.   2)  To commercial users who have paid the licensing fee.
  50.   3)  BBS authors, after they have paid the one-time licensing fee.
  51.  
  52. General help with this protocol engine can be obtained through the
  53. International FidoNet BLUEWAVE Echo.  Netmail (except in the above cases)
  54. will not be answered, but bug reports will be worked on.
  55.  
  56.  
  57.  
  58.  
  59. PURPOSE
  60. -------
  61. To provide a file transfer protocol module specifically designed for use
  62. with The Blue Wave Mail Door.  This is a test program, to be distributed
  63. AT A LATER DATE as a full release.
  64.  
  65. Although the 'windowing' of the transfer screen is designed so that the
  66. current BW mail doors' user status is left on the screen (which is why I
  67. say it is BW-door specific), it can be used in the place of any external
  68. protocol module.
  69.  
  70. The file transfer protocol module is excellent for use on BBS systems, as
  71. it provides security against users uploading files to a remote-defined
  72. path on the BBS system.  (The default, and only, mode of batch uploading
  73. is the same as DSZ/GSZ's "restrict" keyword).  Users will not be able to
  74. upload files to any path except for the path that you specify.  Also, the
  75. FTP does not allow the "overwriting" of an existing file.
  76.  
  77.  
  78. DESCRIPTION
  79. -----------
  80. The file transfer protocol (named "CE-XYZ", and referred to as the FTP
  81. throughout the rest of the document) currently supports the following
  82. protocols:
  83.  
  84.   - Zmodem with 32-bit CRC
  85.   - Zmodem with 16-bit CRC
  86.   - Ymodem-Batch (True Ymodem)
  87.   - Ymodem-G
  88.   - Xmodem CRC/Checksum (CRC is the default, fallback to Checksum if remote
  89.                         end doesn't seem to like the CRC method)
  90.   - Xmodem-1K CRC
  91.  
  92. The FTP can use 4 different methods of "talking" to your serial port:
  93.   - FOSSIL communications (most compatible with FidoNet systems, default)
  94.   - Direct communications (standard for most comm programs)
  95.   - Interrupt driven communications (fastest, takes over INT 14h)
  96.   - Smart Digiboard (up to 16 serial ports.  "Dumb" Digi is not supported
  97.     directly, but the "direct" method should work).
  98.  
  99. Because the FTP can utilize a FOSSIL driver, it can support shared IRQs
  100. (unlike DSZ/GSZ) and "non-standard" IRQs if the FOSSIL driver has the
  101. capability (X00 supports shared IRQs).
  102.  
  103. The FTP is command line driven;  it must be invoked with command line
  104. parameters specifying, at the very least, the locked speed of the port
  105. and the protocol transfer method.
  106.  
  107. In order to accomodate terminal and BBS programs that require the use of
  108. a DSZ-style log file, the FTP will create/append to a DSZLOG if the
  109. following environment variable is set:
  110.  
  111.   SET DSZLOG=dsz.log
  112.  
  113. If the DSZLOG environment variable is not set, then no protocol logging
  114. will take place.  The log file generated by CE-XYZ is 100% DSZ
  115. compatible.
  116.  
  117.  
  118. COMMAND LINE PARAMETERS
  119. -----------------------
  120. In order to successfully invoke the FTP, you must use at least the
  121. following command line parameters:
  122.  
  123.   /L or /B to specify either the locked speed or the line speed (or both).
  124.   /R or /S to specify send/receive mode
  125.   /P, if your modem is not on COM1 to specify the port.
  126.  
  127. Below is a description of all available command line parameters.  Any
  128. command line parameter that does not start with a / or a - is assumed to
  129. be the file name(s) to send or receive.  More on file name parameters in
  130. the next section.  All command lines are case insensitive (capital
  131. letters and lower-case letters will do the same thing.)
  132.  
  133.  
  134. * EXAMPLE COMMAND LINE PARAMETERS ARE GIVEN AT THE VERY END OF THIS DOCUMENT *
  135.  
  136.  
  137.   /T<number>   -  By default, the FTP places its window and other
  138.                   information beginning on line number 8 of the display in
  139.                   order to "fit into" the window left by BW mail doors.  By
  140.                   using /T<number>, you can tell the FTP to place the first
  141.                   line of the window beginning on a different line.
  142.  
  143.                   /T1 through /T8 are valid.  If <number> is greater than
  144.                   8, 8 is used.  If <number> is less than 1, 1 is used.
  145.  
  146.   /N<1st_last> -  If you pass a User Name to the protocol engine, the name
  147.                   will be displayed on the screen so you know who is online
  148.                   (mainly for BBS usage).
  149.  
  150.                   /NGeorge_Hatchew would display my name on the left-most
  151.                   column of the display screen.  Please note that an
  152.                   underscore between names IS REQUIRED.
  153.  
  154.   /P<number>   -  Specifies the COM port to use for the file transfer.  If
  155.                   no port is specified, the driver defaults to COM1.  To
  156.                   invoke the driver on COM2, use "/p2".
  157.  
  158.   /L<number>   -  The LOCKED baud rate of the transfer session, if the serial
  159.                   port should be locked.  High speed modem users should use
  160.                   one of /L19200, /L38400, /L57600, or possibly /L9600.  If
  161.                   you do not specify the locked baud rate, the driver will
  162.                   try to open the port at the rate specified with the /B
  163.                   parameter.
  164.  
  165.   /B<number>   -  The actual line speed of the current connection.  If /L
  166.                   is also specified, /B is used for time and CPS
  167.                   estimations ONLY. If you do not have a locked serial
  168.                   port, you should specify the connect rate of modem with
  169.                   /B.  /B300, /B1200, /B2400, /B7200, etc. are some
  170.                   examples.
  171.  
  172.                   The use of the /B command line parameter is not
  173.                   absolutely required if you use a /L command line
  174.                   parameter, but transfer estimations will be wrong if you
  175.                   do not.  The use of /B with /L is much like the
  176.                   "estimate" command in DSZ/GSZ.
  177.  
  178.   /R<protocol> -  Use the /R parameter to receive files via one of the
  179.                   supported protocols.  The following /R switches are
  180.                   supported:
  181.  
  182.                   /Rx   - Receive file with Xmodem-CRC or Checksum
  183.                   /Rx1k - Receive file with Xmodem-CRC (1024 byte blocks).
  184.                   /Ry   - Receive file(s) with Ymodem-Batch
  185.                   /Ryg  - Receive file(s) with Ymodem-G
  186.                   /Rz   - Receive file(s) with Zmodem
  187.  
  188.   /S<protocol> -  Use the /S parameter to send files via one of the
  189.                   supported protocols.  The following /S switches are
  190.                   supported:
  191.  
  192.                   /Sx   - Send file with Xmodem-CRC or Checksum
  193.                   /Sx1k - Send file with Xmodem-CRC (1024 byte blocks).
  194.                   /Sy   - Send file(s) with Ymodem-Batch
  195.                   /Syg  - Send file(s) with Ymodem-G
  196.                   /Sz   - Send file(s) with Zmodem
  197.  
  198.   /U<method>   -  The /U command line parameter tells the FTP which serial
  199.                   communications method to use.  The <method> can be one of
  200.                   the following:
  201.  
  202.                   /Ufos  -  Use the installed FOSSIL for port communications.
  203.                             This is the default mode.  If you want FOSSIL
  204.                             communications, you need not specify a /U
  205.                             parameter.
  206.  
  207.                   /Udir  -  Use direct (standard) communications.  Next to
  208.                             having an installed, working FOSSIL driver, this
  209.                             method is the most compatible.
  210.  
  211.                   /Ufas  -  Use the FAST, interrupt driven communications
  212.                             routines.  This may not be compatible with all
  213.                             serial cards and/or BIOS.  The FTP will "take
  214.                             over" INT 14h, and restore the previous 14h
  215.                             vector upon termination.  (This should allow you
  216.                             to use /Ufas, even if you also have a FOSSIL
  217.                             driver installed.  A FOSSIL "int 14 recapture"
  218.                             should *not* be necessary upon normal
  219.                             termination.  If you experience lockups, it is
  220.                             most likely interference from other TSR
  221.                             programs or system incompatibilities.  In this
  222.                             case, use /Udir instead.
  223.  
  224.                   /Udig  -  Use the Smart DigiBoard communications interface.
  225.                             The Smart DigiBoard requires the loading of a
  226.                             TSR, much like a FOSSIL driver.  The FTP uses
  227.                             this TSR for communications on up to 8 ports at
  228.                             a time.  DO NOT USE THIS SWITCH UNLESS YOU HAVE A
  229.                             *SMART* DIGIBOARD.  /Udir will work with standard
  230.                             Digiboards.
  231.  
  232.  
  233. Passing File Names to the FTP
  234. -----------------------------
  235. Any command line parameter not preceeded with a "/" or a "-" is assumed
  236. to be the file name to send or receive.
  237.  
  238.  
  239.     SEND Mode
  240.     ---------
  241.     To send files with the FTP, simply enter the name(s) of the files you
  242.     would like to send on the command line, with a full
  243.     drive:\path\filename.exe specification, if the file is not in the
  244.     current directory.  In SEND mode, a file name specification is
  245.     required.
  246.  
  247.     Wildcards (? and *) on the SEND command line are supported.  If the
  248.     requested protocol is a batch protocol (all but Xmodem and Xmodem-1K),
  249.     the FTP will locate all matches to the wildcard specification and then
  250.     begin a batch send.  If the requested protocol is Xmodem or Xmodem-1K,
  251.     only the first directory match to the wildcard specification will be
  252.     sent.  (Xmodem and its variants can only send or receive one file at a
  253.     time).
  254.  
  255.     In addition to wildcards, file LISTS are supported.  Suppose you had a
  256.     straight-ASCII text file containing the following:
  257.  
  258.     --- Contents of FILE.LST ---
  259.     D:\FILES\UPLOAD\ZIPPER.ZIP
  260.     D:\FILES\UPLOAD\FTP.EXE
  261.     E:\CPROG\MYFILE.C
  262.     H:\FD\NODELIST\NODELIST.*
  263.     C:\BWAVE\*.BW
  264.     ----- End of FILE.LST ------
  265.  
  266.     To send all of the files contained in this list, place an "@" symbol in
  267.     front of the list file name, as in:
  268.  
  269.     MM.EXE /P2 /L38400 /B14400 /Sz @FILE.LST
  270.  
  271.     Or, if FILE.LST is not in the current directory, use:
  272.  
  273.     MM.EXE /P2 /L38400 /B14400 /Sz @E:\SOMEWHER\FILE.LST
  274.  
  275.  
  276.     RECEIVE Mode
  277.     ------------
  278.     If the FTP is requested to receive files via one of the batch
  279.     protocols, a file name to receive is NOT required on the command line.
  280.     Files received will be placed in the current directory with the file
  281.     name given by the sending system.
  282.  
  283.     If you would like to place received files in a directory other than the
  284.     current directory in batch protocol mode, simply enter the name of the
  285.     directory on the command line to receive the file(s) to:
  286.  
  287.     MM /P1 /B2400 /Rz E:\Files\Download
  288.  
  289.     If the directory E:\Files\Download exists, the FTP will place the
  290.     received files there.
  291.  
  292.     Supposing you are downloading a file called THISFILE.ZIP via Zmodem,
  293.     and you would like to place it in the directory C:\FILES with the file
  294.     name of MY-DL.ZIP, simply specify the complete file name.  The file
  295.     name received from the sender will be overriden.  Example:
  296.  
  297.     MM.EXE /B1200 /Rz C:\Files\My-DL.Zip
  298.  
  299.     If you are receiving files via Xmodem or Xmodem-1K, a full file name
  300.     specification is REQUIRED on the command line, since these 2 protocols
  301.     do not support the passing of a file name.  Example:
  302.  
  303.     MM /P4 /L38400 /B2400 /Rx E:\Files\Download\Myfile.arj
  304.  
  305.  
  306. EXAMPLE COMMAND LINES
  307. ---------------------
  308. Modem on COM4, locked at 38400 bps, connected at 9600 bps with a user,
  309. receiving a batch upload with Ymodem-G to D:\BBS\FILES\UPLOAD directory:
  310.  
  311.     CEXYZ.EXE /l38400 /b9600 /p4 /ryg d:\bbs\files\upload
  312.  
  313. Modem on COM1 (default), no locked port, connected at 1200bps, receiving
  314. a file via Xmodem:
  315.  
  316.     CEXYZ.EXE /b1200 /rx filename.ext
  317.  
  318. Modem on COM1, no locked port, connected at 2400bps, receiving files via
  319. Zmodem to the current directory:
  320.  
  321.     CEXYZ.EXE /b2400 /rz
  322.  
  323. Modem on Smart Digiboard COM7, locked at 9600bps, connected at 9600bps,
  324. sending a file via Zmodem:
  325.  
  326.     CEXYZ.EXE /Udig /L9600 /P7 E:\FILES\CPROG\CEXYZ.C
  327.  
  328.  
  329.  
  330. SAMPLE ENTRIES INTO THE BWUTILS PROTOCOL EDITOR
  331. -----------------------------------------------
  332. If your port is not locked, you must leave out the /L command line
  333. parameters shown below.  If your port is locked at a different BPS rate,
  334. you must, of course, specify *your* locked port speed in the place of
  335. 38400.
  336.  
  337.  
  338.   *************************************************************************
  339.   If CEXYZ.EXE is not on your DOS PATH statement, you must specify the full
  340.   path in front of "cexyz.exe" shown below.  IT IS NOT ENOUGH TO HAVE CEXYZ
  341.   in your BW mail door directory, because the door changes directories on
  342.   an upload in order to support unregistered-DSZ restrictions on supplying
  343.   an upload path!
  344.   *************************************************************************
  345.  
  346.   Zmodem:
  347.   -------
  348.   Protocol Hotkey : Z                                Default: Yes
  349.   Protocol Title  : Zmodem                           Batch  : Yes
  350.   Send CommandLine: cexyz.exe /p%P /L38400 /b%B /sz %F
  351.   Recv CommandLine: cexyz.exe /p%P /L38400 /b%B /rz %F
  352.  
  353.   Ymodem:
  354.   -------
  355.   Protocol Hotkey : Y                                Default: No
  356.   Protocol Title  : Ymodem                           Batch  : Yes
  357.   Send CommandLine: cexyz.exe /p%P /L38400 /b%B /sy %F
  358.   Recv CommandLine: cexyz.exe /p%P /L38400 /b%B /ry %F
  359.  
  360.   Ymodem-G:
  361.   ---------
  362.   Protocol Hotkey : G                                Default: No
  363.   Protocol Title  : Ymodem-G                         Batch  : Yes
  364.   Send CommandLine: cexyz.exe /p%P /L38400 /b%B /syg %F
  365.   Recv CommandLine: cexyz.exe /p%P /L38400 /b%B /ryg %F
  366.  
  367.   1K-Xmodem:
  368.   ----------
  369.   Protocol Hotkey : 1                                Default: No
  370.   Protocol Title  : Xmodem-1K                        Batch  : No
  371.   Send CommandLine: cexyz.exe /p%P /L38400 /b%B /sx1k %F
  372.   Recv CommandLine: cexyz.exe /p%P /L38400 /b%B /rx1k %F
  373.  
  374.   Xmodem:
  375.   -------
  376.   Protocol Hotkey : X                                Default: No
  377.   Protocol Title  : Xmodem                           Batch  : No
  378.   Send CommandLine: cexyz.exe /p%P /L38400 /b%B /sx %F
  379.   Recv CommandLine: cexyz.exe /p%P /L38400 /b%B /rx %F
  380.  
  381.